Platform Explorer / Nuxeo Platform 2021.47

Contribution org.nuxeo.ecm.platform.forms.layouts.webapp.widgts--widgettypes

This contribution is part of XML component org.nuxeo.ecm.platform.forms.layouts.webapp.widgts inside nuxeo-platform-webapp-base-2021.47.4.jar /OSGI-INF/widgets-contrib.xml

Extension Point

Extension point widgettypes of component WebLayoutManager.

Registration Order

8
The registration order represents the order in which this contribution was registered on its target extention point. This will impact the override/merge behaviour when it is implemented on the target service, and is useful for proper customization of existing contributions.
You can influence this order by adding "require" tags in the containing component declaration, to make sure it is resolved after another component (see "Resolution Order" on components).

Contributed Items

  • <widgetType name="life_cycle_transitions">
          <configuration>
            <title>Life cycle transitions</title>
            <description>
              This widget type displays a selection of available life cycle
              transitions
              given a life cycle state and a life cycle policy.
              <br/>
              It requires the configuration of the first field to map to a String
              value storing the chosen life cycle transition.
              <br/>
              It needs the following properties configuration:
              <ul>
                <li>
                  lifeCycleName: represents the life cycle from which to retrieve
                  the transitions.
                </li>
                <li>
                  currentLifeCycleState: the current state from where to start
                  finding the available transitions.
                </li>
              </ul>
              <br/>
              A standard definition could be:
              <div class="pre">
                &lt;widget name="life_cycle_transitions"
                type="life_cycle_transitions"&gt;
                &lt;labels&gt;
                &lt;label mode="any"&gt;&lt;/label&gt;
                &lt;/labels&gt;
                &lt;fields&gt;
                &lt;field&gt;contextData['lifeCycleTransition']&lt;/field&gt;
                &lt;/fields&gt;
                &lt;properties widgetMode="edit"&gt;
                &lt;property
                name="currentLifeCycleState"&gt;#{layoutValue.currentLifeCycleState}&lt;/property&gt;
                &lt;property
                name="lifeCycleName"&gt;#{layoutValue.lifeCyclePolicy}&lt;/property&gt;
                &lt;/properties&gt;
                &lt;/widget&gt; </div>
            </description>
            <categories>
              <category>document</category>
            </categories>
            <supportedModes>
              <mode>edit</mode>
              <mode>view</mode>
            </supportedModes>
            <fields>
              <list>false</list>
              <complex>false</complex>
              <supportedTypes>
                <type>string</type>
              </supportedTypes>
            </fields>
            <properties>
              <layouts mode="edit">
                <layout name="life_cycle_transitions_widget_type_properties_edit">
                  <rows>
                    <row>
                      <widget>lifeCycleName</widget>
                    </row>
                    <row>
                      <widget>currentLifeCycleState</widget>
                    </row>
                    <row>
                      <widget category="widgetTypeConf">required</widget>
                    </row>
                    <row>
                      <widget category="widgetTypeConf">styleClass</widget>
                    </row>
                  </rows>
                  <widget name="lifeCycleName" type="text">
                    <labels>
                      <label mode="any">Lifecycle name</label>
                    </labels>
                    <helpLabels>
                      <label mode="any">
                        The lifecycle containing transitions to
                        choose.
                      </label>
                    </helpLabels>
                    <fields>
                      <field>lifeCycleName</field>
                    </fields>
                    <properties mode="any">
                      <property name="required">true</property>
                    </properties>
                  </widget>
                  <widget name="currentLifeCycleState" type="text">
                    <labels>
                      <label mode="any">Current life cycle state</label>
                    </labels>
                    <helpLabels>
                      <label mode="any">
                        The life cycle state to choose transitions
                        from.
                      </label>
                    </helpLabels>
                    <fields>
                      <field>currentLifeCycleState</field>
                    </fields>
                    <properties mode="any">
                      <property name="required">true</property>
                    </properties>
                  </widget>
                </layout>
              </layouts>
            </properties>
          </configuration>
          <handler-class>
            org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
          </handler-class>
          <property name="template">
            /widgets/life_cycle_transitions_widget_template.xhtml
          </property>
    
        </widgetType>

    This widget type displays a selection of available life cycle transitions given a life cycle state and a life cycle policy. It requires the configuration of the first field to map to a String value storing the chosen life cycle transition. It needs the following properties configuration: A standard definition could be:

  • <widgetType name="image">
          <configuration>
            <sinceVersion>5.5</sinceVersion>
            <title>Image</title>
            <description>
              <p>
                The image widget displays a file uploader/editor in create or edit
                mode, with additional message tag for errors, and an &lt;img&gt; tag
                displaying the image in other modes.
              </p>
              <li>
                width: the width of the img tag in view mode.
              </li>
              <li>
                height: the height of the img tag in view mode.
              </li>
            </description>
            <properties>
              <layouts mode="view">
                <layout name="image_widget_type_properties_view">
                  <rows>
                    <row>
                      <widget>width</widget>
                    </row>
                    <row>
                      <widget>height</widget>
                    </row>
                  </rows>
                  <widget name="width" type="int">
                    <labels>
                      <label mode="any">Width</label>
                    </labels>
                    <fields>
                      <field>width</field>
                    </fields>
                  </widget>
                  <widget name="height" type="text">
                    <labels>
                      <label mode="any">Height</label>
                    </labels>
                    <fields>
                      <field>height</field>
                    </fields>
                  </widget>
                </layout>
              </layouts>
              <layouts mode="edit">
                <layout name="image_widget_type_properties_edit">
                  <rows>
                    <row>
                      <widget category="widgetTypeConf">required</widget>
                    </row>
                    <row>
                      <widget>acceptedExtensions</widget>
                    </row>
                  </rows>
                  <widget name="acceptedExtensions" type="text">
                    <labels>
                      <label mode="any">Accepted extensions</label>
                    </labels>
                    <helpLabels>
                      <label mode="any">
                        A comma separated list of supported file
                        extensions. Default value: '.jpg, .jpeg, .png, .gif, .tif,
                        .tiff, .psd, .raw, .ai, .svg, .ps, .eps, .epsi, .epsf, .xcf,
                        .bmp'.
                      </label>
                    </helpLabels>
                    <fields>
                      <field>acceptedExtensions</field>
                    </fields>
                  </widget>
                </layout>
              </layouts>
            </properties>
            <categories>
              <category>document</category>
            </categories>
            <supportedModes>
              <mode>edit</mode>
              <mode>view</mode>
            </supportedModes>
            <fields>
              <list>false</list>
              <complex>false</complex>
              <supportedTypes>
                <type>blob</type>
              </supportedTypes>
            </fields>
          </configuration>
          <handler-class>
            org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
          </handler-class>
          <property name="template">/widgets/image_widget_template.xhtml</property>
        </widgetType>

XML Source

<extension point="widgettypes" target="org.nuxeo.ecm.platform.forms.layout.WebLayoutManager">

    <widgetType name="life_cycle_transitions">
      <configuration>
        <title>Life cycle transitions</title>
        <description>
          This widget type displays a selection of available life cycle
          transitions
          given a life cycle state and a life cycle policy.
          <br/>
          It requires the configuration of the first field to map to a String
          value storing the chosen life cycle transition.
          <br/>
          It needs the following properties configuration:
          <ul>
            <li>
              lifeCycleName: represents the life cycle from which to retrieve
              the transitions.
            </li>
            <li>
              currentLifeCycleState: the current state from where to start
              finding the available transitions.
            </li>
          </ul>
          <br/>
          A standard definition could be:
          <div class="pre">
            &lt;widget name="life_cycle_transitions"
            type="life_cycle_transitions"&gt;
            &lt;labels&gt;
            &lt;label mode="any"&gt;&lt;/label&gt;
            &lt;/labels&gt;
            &lt;fields&gt;
            &lt;field&gt;contextData['lifeCycleTransition']&lt;/field&gt;
            &lt;/fields&gt;
            &lt;properties widgetMode="edit"&gt;
            &lt;property
            name="currentLifeCycleState"&gt;#{layoutValue.currentLifeCycleState}&lt;/property&gt;
            &lt;property
            name="lifeCycleName"&gt;#{layoutValue.lifeCyclePolicy}&lt;/property&gt;
            &lt;/properties&gt;
            &lt;/widget&gt; </div>
        </description>
        <categories>
          <category>document</category>
        </categories>
        <supportedModes>
          <mode>edit</mode>
          <mode>view</mode>
        </supportedModes>
        <fields>
          <list>false</list>
          <complex>false</complex>
          <supportedTypes>
            <type>string</type>
          </supportedTypes>
        </fields>
        <properties>
          <layouts mode="edit">
            <layout name="life_cycle_transitions_widget_type_properties_edit">
              <rows>
                <row>
                  <widget>lifeCycleName</widget>
                </row>
                <row>
                  <widget>currentLifeCycleState</widget>
                </row>
                <row>
                  <widget category="widgetTypeConf">required</widget>
                </row>
                <row>
                  <widget category="widgetTypeConf">styleClass</widget>
                </row>
              </rows>
              <widget name="lifeCycleName" type="text">
                <labels>
                  <label mode="any">Lifecycle name</label>
                </labels>
                <helpLabels>
                  <label mode="any">
                    The lifecycle containing transitions to
                    choose.
                  </label>
                </helpLabels>
                <fields>
                  <field>lifeCycleName</field>
                </fields>
                <properties mode="any">
                  <property name="required">true</property>
                </properties>
              </widget>
              <widget name="currentLifeCycleState" type="text">
                <labels>
                  <label mode="any">Current life cycle state</label>
                </labels>
                <helpLabels>
                  <label mode="any">
                    The life cycle state to choose transitions
                    from.
                  </label>
                </helpLabels>
                <fields>
                  <field>currentLifeCycleState</field>
                </fields>
                <properties mode="any">
                  <property name="required">true</property>
                </properties>
              </widget>
            </layout>
          </layouts>
        </properties>
      </configuration>
      <handler-class>
        org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
      </handler-class>
      <property name="template">
        /widgets/life_cycle_transitions_widget_template.xhtml
      </property>

    </widgetType>

    <widgetType name="image">
      <configuration>
        <sinceVersion>5.5</sinceVersion>
        <title>Image</title>
        <description>
          <p>
            The image widget displays a file uploader/editor in create or edit
            mode, with additional message tag for errors, and an &lt;img&gt; tag
            displaying the image in other modes.
          </p>
          <li>
            width: the width of the img tag in view mode.
          </li>
          <li>
            height: the height of the img tag in view mode.
          </li>
        </description>
        <properties>
          <layouts mode="view">
            <layout name="image_widget_type_properties_view">
              <rows>
                <row>
                  <widget>width</widget>
                </row>
                <row>
                  <widget>height</widget>
                </row>
              </rows>
              <widget name="width" type="int">
                <labels>
                  <label mode="any">Width</label>
                </labels>
                <fields>
                  <field>width</field>
                </fields>
              </widget>
              <widget name="height" type="text">
                <labels>
                  <label mode="any">Height</label>
                </labels>
                <fields>
                  <field>height</field>
                </fields>
              </widget>
            </layout>
          </layouts>
          <layouts mode="edit">
            <layout name="image_widget_type_properties_edit">
              <rows>
                <row>
                  <widget category="widgetTypeConf">required</widget>
                </row>
                <row>
                  <widget>acceptedExtensions</widget>
                </row>
              </rows>
              <widget name="acceptedExtensions" type="text">
                <labels>
                  <label mode="any">Accepted extensions</label>
                </labels>
                <helpLabels>
                  <label mode="any">
                    A comma separated list of supported file
                    extensions. Default value: '.jpg, .jpeg, .png, .gif, .tif,
                    .tiff, .psd, .raw, .ai, .svg, .ps, .eps, .epsi, .epsf, .xcf,
                    .bmp'.
                  </label>
                </helpLabels>
                <fields>
                  <field>acceptedExtensions</field>
                </fields>
              </widget>
            </layout>
          </layouts>
        </properties>
        <categories>
          <category>document</category>
        </categories>
        <supportedModes>
          <mode>edit</mode>
          <mode>view</mode>
        </supportedModes>
        <fields>
          <list>false</list>
          <complex>false</complex>
          <supportedTypes>
            <type>blob</type>
          </supportedTypes>
        </fields>
      </configuration>
      <handler-class>
        org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
      </handler-class>
      <property name="template">/widgets/image_widget_template.xhtml</property>
    </widgetType>

  </extension>